-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
BLD: validate_docstrings.py add ignore_known_fail argument #25617
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
BLD: validate_docstrings.py add ignore_known_fail argument #25617
Conversation
@@ -946,9 +977,14 @@ def header(title, width=80, char='#'): | |||
action='store_true', help='if this flag is set, ' | |||
'deprecated objects are ignored when validating ' | |||
'all docstrings') | |||
argparser.add_argument('--ignore_known_fail', default=False, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thoughts on the default? I would expect that if you're whitelisting thees failures, you wouldn't need to also pass --ignore-known-fail
. Not a big deal either way since this is just in CI.
Can you add a couple sentences to contributing_docstring.rst
saying when and how to use this?
Might have missed some conversations but not sure I am on board with this change. Wouldn't it be easier to just update those docstrings on our end? |
@WillAyd |
Closing as stale though not sure this is the right approach anyway. If interested in continuing let's pick up conversation back in referenced issue |
a solution for the problem of inherited docstrings not passing docstring tests preventing errors to be added to the CI
code_checks.sh